package com.gitee.helioz.openai.api.dto;

import com.google.gson.annotations.SerializedName;
import lombok.Data;

/**
 * 〈使用情况统计〉
 * <p>Usage 可以帮助用户了解每次 API 调用使用了多少令牌，从而控制 API 使用量并进行计费或限制。</p>
 *
 * @author <a href="https://gitee.com/helioz">Morning Starr</a>
 */
@Data
public class UsageDTO {
    /**
     * 表示输入 prompt(文本,包括编辑前和编辑后) 使用的 token 数量
     */
    @SerializedName("prompt_tokens")
    private int promptTokens;
    /**
     * 表示生成聊天回复的 token 数量
     */
    @SerializedName("completion_tokens")
    private int completionTokens;
    /**
     * 表示 API 调用总共使用的 token 数量(包括输入文本和生成的编辑文本)
     */
    @SerializedName("total_tokens")
    private int totalTokens;
}
